AutoLISP Reference Guide

.txt files, in VLX

/= (not equal to)

> (greater than)

>= (greater than or equal to)

~ (bitwise NOT)

3D Object Snap mode

ActiveX-compatible

angles, specifying

in user coordinate system

A

absolute values

acad-pop-dbmod function

acad-push-dbmod function

acad.cfg, AppData section [1], [2]

acapp.arx file [1], [2]

accessing files with AutoLISP

acet-layerp-mark function

acet-layerp-mode function

acet-laytrans function [1], [2], [3]

creating 3D points compatible with

creating transformation matrices

getting object properties

add, layerstate

allocating memory [1], [2]

AND, list of integers

ANGBASE system variable

converting from string to radian

converting to strings

defined by two endpoints

measured in radians

measuring cosine in radians

anonymous functions, defining

antilogarithms, and real numbers

appending lists

application objects

creating new instances of

returning running instances of

application-handling functions, ObjectARX

application-specific data

from acad.cfg file, retrieving

in reactor objects

writing to the AppData section of acad.cfg

AppData section of acad.cfg

connecting with ActiveX [1], [2]

forcing to quit

loading ObjectARX

ObjectARX, listing

separate-namespace VLX

starting Windows applications

unloading ObjectARX

using extended data

arctangents, measured in radians

arguments, passing to functions

dimension boundaries of

returning end index of

See also safearrays

ARX applications. See ObjectARX applications

ASCII character codes

converting first character

converting to single characters

from keyboard input buffer

representing characters

association lists

associative dimensions

and dotted lists

first in a string, converting

retrieving DCL values

AutoCAD commands

adding to built-in command set

executing [1], [2]

retrieving localized names of

AutoCAD documents, function availability

AutoCAD graphics screen

AutoCAD status line, writing text to

AutoLISP data, displaying as output from prin1/princ

automatic loading

of AutoLISP files

of ObjectARX files

B

backslash, control codes (table)

base points, specifying distance

bits, specifying to shift integers

bitwise Boolean functions

bitwise NOT operator

blackboard namespace

returning variable value from

setting variables

block references

attributes, selecting

definition data

with attributes

updating screen image

inserting in editor reactors

writing to reactor events

Boolean bitwise functions

boundaries, in safearrays

built-in functions

bytes, for file size

C

calibrations, digitizer coordinates

callback functions

and inactive namespaces

printing arguments in Trace window

case conversions

character codes

ASCII. See ASCII character codes

converting from strings

converting case of

quantity in strings

applications, forced quit

applying functions to

color selection dialog box, displaying [1], [2], [3]

command events, and editor reactors

printing expressions to [1], [2], [3]

printing newlines to

command reactor events (table)

adding to AutoCAD

English name in AutoCAD

executing in AutoCAD [1], [2]

localized name in AutoCAD

common denominators, finding greatest

compare, layerstate

comparison function

in lists [1], [2]

complex objects, accessing definition data [1], [2]

expressions into lists

multiple strings

conditional functions, primary

conditionally evaluating expressions

angles to radians

case of alphabetic characters

ename to VLA-object

floating point to real values

integers to strings

model space units to paper space units

numbers to strings

paper space units to model space units

to real numbers

values, to other units of measurement

VLA-object to ename

coordinate systems

translating points

coordinates, in text boxes

corners, user input for rectangles

cosine of angles

creating inside area of

defining parameters of

finding nearest point of

first derivative of

infinite ranges of

at specified distance

at specified distance

at specified parameter

projecting onto planes

second derivative

to selected point

start parameter

WCS start point

D

data types (list)

database reactors, creating

DBMOD system variable

restoring value stored with acad-push-dbmod

storing current value

DCL values, retrieving

untrace function

decrement operator

decrementing numbers

deep cloning, reactor notification

DeepClone reactor events, (table)

deepclone reactors, creating

defining function symbols as external subroutines

definition data

of complex objects [1], [2]

definitions, retrieving data for objects

defun-q, displaying defined function

delete, layerstate

objects [1], [2]

delimiters, in multiple expressions

adding strings to active list

attributes with DCL values

color selection [1], [2], [3]

displaying [1], [2]

displaying slides in

drawing vectors in

ending active lists

ending creation of images

for error messages

for file selection

forcing display of

modifying strings in active list

processing lists

remaining active

retrieving DCL values of attributes

retrieving runtime values of tiles

specifying tiles

terminating [1], [2]

tile mode, setting

tile values, setting

unloading DCL files

warning message

accessing objects

adding nongraphical objects

erasing LISP data

finding next item

listing LISP data

removing entries

renaming entries

retrieving LISP data

searching items

storing LISP data

DIESEL menu expressions

digitizers, setting calibrations

of arrays [1], [2]

file names referring to

listing all files

using path names

displacements, translating

pausing for user input of

specifying points

divide operator

division, determining remainders

DocManager reactor events (table)

document reactors, creating

last nondeleted object

paper space layouts

DWG reactor events (table)

DWG reactors, creating

DXF reactor events (table)

DXF reactors, creating

E

editor reactor events (table)

editor reactors

command event notification

modifying AutoCAD window notification

modifying xrefs

See also reactors

system variable change notification

toolbar bitmap change notification

undo event notification

writing to block notification

adding to beginning of list

all but first of a list

first of a list

nth element of lists

quantity in lists

removing from lists

reversing in lists

second of a list

supplying as arguments for lists

third of a list

end-of-line markers, open files

angle returned from

equal to start point in curves

adding to selection sets

assigning handles

new instance of

from selection sets

determining if readable

handles and [1], [2]

identifying symbols

in selection sets

last nondeleted

linking as extended data

modifying definition data

naming [1], [2], [3]

nongraphical, accessing

number in selection set

releasing in drawings

restoring deleted entities

retrieving definition data

retrieving LISP data

returning next drawing entity

searching in symbol tables

selecting [1], [2]

selecting for set

specifying properties

storing LISP data

top level in Auto CAD

transforming to VLA-object

transforming VLA-object to

TypeLib information

updating on screen

environment variables

returning value of

setting values for

spelling requirements for

equal to operator

equality between expressions [1], [2], [3]

user-defined function

VLX applications

displaying in dialog boxes

for quitting applications

in error objects

returned from vl-catch-all-apply [1], [2]

viewing error messages in

evaluating expressions [1], [2]

conditionally (if...)

for all members of a list

repetition specified

using EVAL function

evaluating lists, primary condition

events, current within reactor's callback

executing AutoCAD commands

expand function, setting segment size for

exponents, specifying power

export, layerstate

determining whether equal

determining whether identical

a specified number of times

for all members of a list

printing to command line [1], [2], [3]

re-evaluation, specified

returning without evaluating

setting symbol values to [1], [2]

writing to files [1], [2], [3]

extended data, naming applications

external subroutines, defining symbols as

F

FAS files, compiling source code into

prompting user for

acad.cfg [1], [2]

determining size of

end-of-line marker

listing in directories

in AutoCAD documents

temporary files

with extension only

without directory or extension

reading strings from

returning ASCII code from

searching library paths for

time of last modification

writing characters to

writing expressions to [1], [2], [3]

writing strings to

filled rectangles, drawing in dialog box

find. See search

first list or atom from a string

Flip Screen function key

floating point values

converting angles from strings to

converting to real values

forcing an application to quit

forcing display of dialog boxes

function calls, keywords

function symbols

defining as external subroutines

applying to objects

availability in AutoCAD documents

Boolean, bitwise

defined in lists

setting symbols as

displaying list structures

exported by VLX

extended data-handling

into VLX namespace

loading Visual LISP extensions to AutoLISP

G

garbage collection

getlastrestored, layerstate

getlayers, layerstate

getnames, layerstate

graphics screen

displayed in AutoCAD

switching to text screen

graphics vectors

in dialog box images

greater than operator

greater than or equal to operator

gripped objects [1], [2]

H

for new objects

returning object names by

has, layerstate

height of tiles, retrieving in dialog box units

invoking [1], [2]

registering user-defined commands with

I

creating in dialog boxes

displaying slides

ending creation in dialog boxes

updating of screen

vectors in dialog boxes

import, layerstate [1], [2]

importfromdb, layerstate

importing data, from type libraries

importing functions

increment operator

incrementing numbers

index of list element, determining

indexed elements of selection sets

infinite ranges, in curves

input devices, reading from AutoCAD

input, restricting users

insert reactor events (table)

converting from real numbers

converting from strings

converting to strings [1], [2], [3]

greatest common denominator

largest in list

limits for user input

list using bitwise AND

list using bitwise OR

lists combining characters

pausing for user input of

quantity of string characters

range of values

shifting by specifying bits

smallest in list

intercepting errors

intersections, of lines

K

keyboard input buffer

reading strings from

returning ASCII code from

for user-input function calls

methods for abbreviating

L

largest numbers

Layer Translator, AutoLISP function for [1], [2], [3]

LAYERPMODE setting [1], [2]

converting to standard settings [1], [2], [3]

tracking changes to [1], [2]

layerstate-addlayers

layerstate-compare

layerstate-delete

layerstate-export

layerstate-getlastrestored

layerstate-getlayers

layerstate-getnames

layerstate-import

layerstate-importfromdb

layerstate-removelayers

layerstate-rename

layerstate-restore

layerstate-save

layouts, paper space

less than operator

less than or equal to operator

library paths, searching for files

angle of, in radians

determining intersections

linker reactor events (table)

linker reactors, creating

linking arguments with Visual LISP compiler

LISP reactor events (table)

LISP reactors, creating

list structure of functions, displaying

adding first element

comparison function [1], [2]

constructing [1], [2], [3]

constructing dotted lists

deleting beginning characters

deleting end characters [1], [2]

deleting leading characters

determining index of item

element index values

eliminating duplicate elements [1], [2]

evaluating primary conditions

first expression, converting

item position in

last element in

length, determining

linked to objects as extended data

number of elements in

passing to functions

quantity of elements

remainder, obtaining

removing elements from

replacing old items

reversing elements

searching for remainder

second element, obtaining Y coordinate

substituting new items

supplied arguments and

testing elements in [1], [2], [3], [4], [5]

third element, obtaining Z coordinate

valid list definitions

extended Visual LISP functions

See also unloading

Visual Basic projects

for AutoLISP commands

for ObjectARX commands

logical bitwise AND

logical bitwise OR

logical bitwise shift of integer

logical OR of expression

logs, natural logs of numbers

lowercase characters, converting

M

macros, Visual Basic

mathematical functions

division [1], [2]

equality checking [1], [2], [3]

less than or equal to

MCS. See Model Coordinate System

measurements, converting values

measuring text objects

setting segment size

status in AutoLISP

menu commands, issuing

menugroups, loading

DIESEL expressions

calling ActiveX

converting transformation matrix for

determining object support for

MIRROR3D command

miscellaneous reactor events (table)

Model Coordinate System (MCS)

model space units

converting paper space units to

converting to paper space units

Model to World Transformation Matrix

modifying, strings in active dialog box lists

mouse reactor events (table)

mouse reactors, creating

multiple vectors, on graphics screen

multiply operator

N

named object dictionary, entity name of

of entities in selections sets

of objects, returning [1], [2], [3]

blackboard namespace variables [1], [2]

importing functions

See also separate-namespace VLX

variable values [1], [2]

variables in open documents

commands in AutoCAD

temporary files

with AutoCAD file dialog box

valid characters for symbols

negative numbers, verifying

nested entities

newlines, printing to command line

checking variable for [1], [2]

testing list elements for

testing predicate for

nondeleted last object, returning name of

nongraphical objects, adding to dictionaries

not equal to operator

nth element of a list

absolute values of

checking equality of

common denominators

converting to real numbers

converting to strings

evaluating to zero

negative, verifying

See also real numbers

O

Object Coordinate System (OCS)

object events (table)

object reactors

adding to list of owners

removing from list of owners

See also reactors

Object Snap mode

specifying points

ObjectARX applications

listing loaded applications

loading associated files

reactor notification and

undefining symbols

adding to selection sets

assigning handles

changing in drawing database

creating in drawings

creating new instance of

creating selection sets from

deleting from selection sets

determining if erased

determining if readable

extended object data, functions

identifying symbols

last nondeleted

linked as extended data

methods applicable to, listing

methods supported by

modifying definition data

modifying in AutoCAD drawings

naming [1], [2], [3]

adding to dictionaries

number in selection set

redrawing in current viewport

releasing in drawings

restoring deleted objects

retrieving definition data

retrieving LISP data

returning next drawing object

searching symbol tables for

selected and gripped [1], [2]

selecting [1], [2], [3]

selecting for set

setting properties in ActiveX

specifying properties

storing LISP data

testing for selection set membership

top level in AutoCAD

transforming ename to VLA-object

transforming VLA-object to ename

TypeLib information

updating screen image

/= (not equal to)

> (greater than)

>= (greater than or equal to)

~ (bitwise NOT)

optimizing arguments with Visual LISP compiler

output. See writing

P

paper space units

converting model space units to

converting to model space units

paper space, current layouts in

matching with wild cards

replacing in strings

searching in strings

periodic curves

persistent reactors, declaring

containing curves

nearest point on projected curve

pausing for user input of

transforming coordinate systems

translating between coordinate systems

definition data

updating screen image

pop-up lists, processing in dialog boxes

setting in ActiveX

specifying in objects

Q

quit/exit abort error message

quitting applications, forcing

R

arctangents measured in

converting strings to

converting to strings

reactor events (table)

reactor objects. See reactors

application-specific data

callback conditions

data associated with

deep cloning notification

disabling all for a specified type

disabling one reactor

drawing event notification

DXF file event notification

enabled, determining

existing, list of

for drawing document events

identifying type of

inactive namespace and

LISP event notification

miscellaneous editor types

mouse event notification

object reactors, constructing

of ObjectARX application notification

overwriting application-specific data

in current drawing

replacing callback functions

See also editor reactors

transient, making

reading, AutoCAD input devices

and natural logs

converting from floating point

converting from numbers

converting from strings

converting to smaller integers

converting to strings

largest in list

pausing for user input of

smallest in list

converting angles from radians to

converting floating point values to

corners, pausing for user input

in dialog box image tiles

recursion, in loading files

registry keys, creating in Windows

registry path, in AutoCAD

remainders, in division

removelayers, layerstate

removing. See deleting

rename, layerstate

dictionary entries

restore, layerstate

runtime values of dialog box tiles, retrieving

S

adding elements

dimension boundaries of [1], [2]

displaying as lists

lower boundaries

number of dimensions

returning start index of

specifying indexes of elements

storing data in elements of

upper boundaries

save, layerstate

saving data, in session boundaries

screen images, updating

screen menus, entering text in

displaying messages

dual-screen display

Flip Screen function key

graphics for AutoCAD

switching graphics screen to text screen

updating object image

writing characters to

writing strings to

AutoCAD library path

files, end-of-line markers

segments, setting size of

selecting objects [1], [2]

adding new objects

creating [1], [2]

creation information

deleting objects from

indexed elements of

members, determining

number of objects in

object selection methods (list)

point descriptor IDs (table)

returning entity names

selected and gripped [1], [2]

selection method IDs (table)

testing for membership of

separate-namespace VLX

determining if loaded

importing functions to

session boundaries, saving data

slides, displaying in dialog boxes

smallest numbers

SNAPANG system variable

SOLPROF command

source code, compiling into FAS files

square roots, as real numbers

status line,writing text to

status of menu items

adding inactive dialog box lists

adding/modifying in a dialog box list

alphabetizing list of

concatenating multiple strings

containing AutoLISP version number

angular value in radians to

from angle to radians

to real numbers

displaying in prompt area

longest common prefix

number of characters in

pausing for user input of

reading from files

replacing patterns

substituting characters

subkeys, in Windows registry

subroutines, external

substituting list items

substrings. See strings

subtract operator

checking names of valid characters

finding next item

for object names

for symbol names

defining current atoms list

determining if nil [1], [2]

external subroutines

function symbols

identifying for objects

invalid characters (table)

name in uppercase

naming with valid characters

searching for names in symbol tables

setting as functions

setting values to expressions [1], [3]

undefining for ObjectARX

value bound to [1], [2]

system variables

environment variable names

retrieving values of

See also environment variables

T

tablet (digitizer) calibrations

temporary files, naming

terminating dialog boxes [1], [2]

test functions, for lists [1], [2], [3], [4], [5]

in screen menus

on AutoCAD status line

text boxes, diagonal coordinates

text objects, measuring

text screen, switching from graphics screen

creating images in dialog boxes

displaying slides in

managing data in dialog boxes

mode for dialog boxes

runtime values of

selecting in dialog boxes

setting value in dialog boxes

trace flag, clearing

trace function, debugging

Trace window, callback arguments

transformation matrix

translating points or displacements

trapping errors

truncating numbers

type function, data types (list)

type libraries, importing data from

TypeLib information

U

UCS. See user coordinate system

undefining function symbols

undeleting objects

units of measurement, converting values and

See also loading

VLX applications

untrace function, debugging

uppercase characters, converting

user coordinate system, 3D points

Help file commands

keyboard input buffer

for function calls

opening dialog boxes

restricting type of

selecting objects without user input

selecting tiles

terminating dialog boxes

user-definable error-handling function

V

bound to symbols

converting to other units of measurement

copying values into document namespaces

determining if numeric

in blackboard namespace [1], [2]

retrieving values from namespace

valid list definitions

changing data type of

determining data type of

returning values of

drawing in viewports

drawing on graphics screen

in dialog box images

of loaded menugroups

of negative numbers

of nil evaluation [1], [2]

of real numbers or integers

version of current AutoLISP

VIEWPORT entity type

clearing current

current configurations

drawing vectors

listing descriptors

current viewport

specifying views

vectors, drawing

views, establishing

Visual Basic projects

linking and optimizing arguments

loading extensions to AutoLISP

VLA-objects, getting properties

VLX applications

.txt resource files in

and current document

determining if loaded

exporting functions

invoking from another namespace

separate-namespace. See separate-namespace VLX

W

warning message, in dialog boxes

WCS. See World Coordinate System

width of tiles, retrieving in dialog box units

wild-card pattern match

Windows applications, starting

Windows registry

creating keys in

deleting keys or values from

stored data for keys

World Coordinate System

endpoints in curves

start point in curves

transforming entity definition data points to

expressions to files [1], [2], [3]

X

xdata. See extended data

Y

Y coordinate, obtaining

Z

Z coordinate, obtaining

zero, testing number for